Distributed software applications in the HAVi home network

ABSTRACT

An extension to the HAVi specification is defined which enables the discovery and exchange of portable software elements, i.e. application modules ( 5   a   ; 5   b ), within the HAVi home network in a defined way. In particular, the sharing of an application module ( 5   a   ; 5   b ) between several controller devices ( 1   a   , 2   a   ; 1   b - 3   b ) is enabled.

[0001] The present invention concerns a method to handle an application module by a controller device within a network and means to carry out said method within the network. In particular, the present invention relates to a home network according to the HAVi specification, i.e. the specification of the home audio/video interoperability architecture.

[0002] Generally, a HAVi network comprises several devices each of which can either be a controller device to control other devices or which can be a target device, e.g. a controllable device being controlled by a controller device. Further, the HAVi specification defines an environment for home network application software that runs independently on a single controller device which must be a Full AV device (FAV) in the network. This application can control target devices which might be Base AV devices (BAV) via their device control module (DCM). Target devices can provide their DCM and applications (havlets) which are uploaded to one controller device to be executed in order to control that target device. Applications can also be downloaded from outside the home network, e. g. via the internet, in order to update/upgrade device functionality, maintenance or other purposes.

[0003] The functionality of havlets and application modules is described in sections 3.5.3 and 3.9 of the HAVi SPECIFICATION 1.0, Version 1.0- Jan. 18, 2000 which content is herewith included by reference into this application. Section 3.9 describes that the way application modules are handled is proprietary as well as the way a FAV finds and installs third-party application modules which are supplied via a disk, internet or any other means. However, it is described that application modules are conceptionally similar to DCMs which allow havlets to use them to provide a proprietary application that offers an user interface for the control of a specific target device.

[0004] Further, in the introductory part of section 3.5 it is set out for the handling of a DCM code unit which is provided by a BAV target device that when a BAV target device is attached to a HAVi network with one or more FAVs, one of them uploads and installs the DCM code unit to make the BAV target device available to other HAVi components.

[0005] Since the HAVi specification does not show how to handle an application module by a controller device within the network it is the object underlying the present invention to provide such a method and means which can carry out said method.

[0006] The method according to the present invention is defined in independent claim 1. Preferred embodiments thereof are defined in dependent claims 2 to 8. Means which are able to carry out said method are defined in claims 9 to 12.

[0007] The method to manage application modules within a controller device of a network according to the invention is characterized by the steps of maintaining a database of application modules provided by said controller device and allowing access to said database via the network; and providing application program interfaces for managing the behaviour of application modules provided by said controller device and provided by other controller devices within the network to said controller device.

[0008] Therewith, the present invention provides the concept of application modules which can be shared by more than one controller device within the network. According to the above mentioned HAVi specification the distribution of applications among multiple controller devices (FAVs) in the network is not provided for havlets or for application modules that are not bound to the control of a particular network target device.

[0009] In this context “sharing” can mean:

[0010] to concurrently execute an application module independently on more than one controller device,

[0011] to concurrently execute an application module on more than one controller device so that an interaction in-between the controller devices executing said application module is performed based on said application module,

[0012] an application-specific user interaction which means that a controller device which provided or first executed the application module acts as a server and all other controller devices which executed the application module thereafter act as clients, and/or

[0013] an application module uses a common data base stored somewhere in the network.

[0014] Examples of such applications could be an A/V intercom or multi-user video games. Also Back-office applications will be possible, e.g a family document repository with multiple access from several devices in the Home Network. An Application Programming Interface (API) as a definitin of a basic life-cycle management API for the latter example might also be adopted in DVB-J, MHP (Multimedia Home Platform) which has the purpose of managing several applications on a (lone) MHP receiver (references to these standards and explanations of their content can be found on the DVB homepage under “www.dvb.org/standards”).

[0015] Therewith, according to the invention shared applications might be distributed among multiple controller devices in the network in that they are stored on one controller device and might be loaded by other controllers, also passing an application module from one controller to other controllers within the network is possible.

[0016] Said behaviour of an application module might comprises import/export, execution and termination of said application module.

[0017] Preferrably the method according to the invention further comprises the step of listing all application modules which are available within the network and providing said list to said controller device.

[0018] Therewith all controller devices within the network know which different applicattion modules are available within the network to be able to load, execute and terminate them.

[0019] In case said network is a HAVi network said application modules are preferrably havlets which are HAVi level-2 GUI compliant, i.e. which have a graphical user interface according to HAVi level-2.

[0020] Further preferrably in case said network is a HAVi network the method according to the invention additionally comprises the step of controlling the exposure and loading of an application module similar to the control of a device control module manager for device control module code modules, but allowing a sharing of an application module between more that one controller device within said network.

[0021] Therewith it is secured that application modules which are managed according to the present invention are basically treated in a manner which is familiar within HAVi.

[0022] This method according to the present invention can be carried out by an application control manager which might be realized as hardware or as a computer program which might be stored on a computer accessible storage means.

[0023] Preferrably, said application module manager has to be executed by a FAV to enable the FAV to share application modules. In this case all the functionality according to the present invention described above is available within therespective FAV.

[0024] Further objects, features and advantages of the present invention will be better understood from the following description of examples for shared applications in a HAVi network and a preferred embodiment of the invention taken in conjunction with the accompanying drawings, wherein

[0025]FIG. 1 shows an example of a multi-user application in HAVi,

[0026]FIG. 2 shows an example of a client-server application in HAVi, and

[0027]FIG. 3 shows the new HAVi FAV Architectural Diagram including the Application Module Manager (AMM) according to the present invention.

[0028] As a first example FIG. 1 shows two users 1 a, 2 a of an i.LINK/IEEE1394 based HAVi network, namely a first user FAV 1 a and a second user FAV 2 a which are exemplary pictured as television sets. Further, the network bus 4, i.e. an i.LINK/IEEE1394 serial bus, might connect several other users, e.g. a further FAV.

[0029] Each of the users is HAVi complient, i.e. since the first and the second users 1 a, 2 a are Full AV devices they can execute HAVi applications and communicate through the serial bus 4 via a runtime environment 6 (virtual machine) for HAVi, e.g. written in JAVA, a HAVi messaging system 7 and a native home network driver interface 8, e.g. an i.LINK interface, respectively comprised within each of said first and second users 1 a, 2 a.

[0030] It is shown that the first and second users 1 a, 2 a execute the same HAVi application module 5 a, namely an application “GAME”, i.e a shared application. The HAVi application 5 a named “GAME” is treated as a first instance by the first user 1 a and as a second instance by the second user 2 a.

[0031] In this context instance could either mean that the actual execution is independent from each other, i.e. each user independently executes the application, or that the users interact with each other on basis of said application, i.e. that a multi-user application is executed.

[0032] The second example of a shared application depicted in FIG. 2 shows a client-server application in an i.LINK/IEEE1394 based HAVi network which comprises—among possible other devices—three full AV devices, namely a server 1 b, a third user 2 b and a fourth user 3 b. Equal to the first and second users 1 a, 2 a shown and described in connection with FIG. 1 the third and fourth users 2 b, 3 b actually execute one HAVi application 5 b and can communicate through the serial bus 4 via a runtime environment 6 (virtual machine) for HAVi, e.g. written in JAVA, a HAVi messaging system 7 and a native home network driver interface 8, e.g. an i.LINK interface, respectively comprised within each of said hird and fourth users 2 b, 3 b. The server 1 b does not comprise a runtime environment 6 (virtual machine) for HAVi, but the actually executed HAVi application 5 b might communicate directly through the HAVi messaging system 7 and the native home network driver interface 8 of the server 1 b with the serial bus 4.

[0033] As described in connection with the first example of a shared application all shown FAVs, i.e the server 1 b, the third user 2 b and the fourth user 3 b, execute the same application module 5 b, in this case an application “Database”. In particular the server 1 b executes the application 5 b “Database” as the server part of a database and the third and fourth users 2 b and 3 b which are again exemplary depicted as TV-set also execute the HAVi application 5 b “Database”, but as a first client and a second client, respectively.

[0034] Of course, all application instances (multi-user) or components (client-server) communicate using the HAVi messaging system. The types and contents of messages are proprietary to the respective application.

[0035] In the following a possible extension to the HAVi SPECIFICATION 1.0, Version 1.0- Jan. 18, 2000 is exemplary given as a preferred embodiment of the invention to further elucidate the method of the invention as described above. Within this example portions of the existing HAVi specification which would be extended or after which new parts would be inserted are indicated.

[0036] 1.1 New HAVi FAV Architectural Diagram Including AMM

[0037] (Amendment to Section 2.4.4 of the Above Mentioned HAVi Specification)

[0038] The new HAVi FAV Architectural Diagram Including AMM is depicted in FIG. 3 which shows the AMM according to the present invention on the same layer as the Registry, Event Manager, Stream Manager, Recource Manager, DCM Manager and the DCMs.

[0039] 1.2 Application Module

[0040] (Amendment to Section 3.9 of the Above Mentioned HAVi Specification)

[0041] The Application Module (AM) API is extended to provide defined API calls and events to manage the life cycle of HAVi applications.

[0042] ApplicationModule::Execute

[0043] ApplicationModule::Terminate

[0044] AM's must indicate changes in their state via the events:

[0045] ApplicationModuleStarted

[0046] ApplicationModuleTerminated

[0047] 1.3 Application Module Manager

[0048] (Would be New Section 3.10 within the Above Mentioned HAVi Specification)

[0049] The Application Module Manager (AMM) provides a defined framework for the management of application modules (AM's) in HAVi. The method of introducing Application Modules (AM's) to the network, i.e. to an FAV node, is proprietary, but once an AM is present on any FAV node, the AMM on that FAV enables the AM to be used by other FAV's in the network.

[0050] The AMM provides the mechanism for AM discovery and execution for the FAV in which an AMM is hosted. Each AMM maintains a database of AM's available at that FAV and provides API's for managing the behaviour of both these AM's and AM's provided on another FAV, made available via the AMM on that FAV. Behaviour basically consists of the import/export (within HAVi), execution and termination of an AM.

[0051] The AMM lists AM's which are available in the network Only when an AM is launched in an FAV does a corresponding entry in the HAVi Registry become established.

[0052] The AMM is an optional module for FAV nodes only. Each FAV that wishes to be able to run AM's hosted on another FAV, or to host AM's to be shared in the network, must implement the AMM.

[0053] The AMM enables the provision of networked and device-independent AM's. Due to the proprietary nature of the internals of an AM, the concept of launching an AM from a remote FAV is specific to that AM. For example, the AM instance launched on the FAV which provided the AM originally could act as a server, and each launch of that AM from a remote FAV could instantiate the client part of that application, thus realising a client/server type of application. Alternatively, all instantiations of an AM could be identical, but could interact with eachother, to enable multi-user networked applications. AM instances would communicate with eachother via the HAVi messaging system. The message contents are proprietary, so that HAVi messages between AM's are meaningful only within the realm of the original AM.

[0054] 1.4 Application Module Manager

[0055] (Would be Inserted as Section 5.12 into the Above Mentioned HAVi Specification, which Implies that Sections 5.12, 5.13, and 5.14 of the HAVi SPECIFICATION 1.0 Would be Renumbered) Services Provided Comm Resv Service Type Locality Access Prot AMManager::ExecApplicationModule M local AMManager::GetApplicationModules M global AMManager::GetApplicationModuleAttributes M global AMManager::InstallApplicationModule M global trusted AMManager::KillApplicationModule M local AMManager::TransferApplicationModule M global AMM AMManager::UninstallApplicationModule M global trusted AmInstallIndication E global AmUninstallIndication E global AmExecIndication E global AmKillIndication E global Application Module Manager Data Structures

[0056] Application Module Manager Data Structures

[0057] ApplicationModuleAttributes struct { wstring applicationModuleName; wstring platformName; wstring vendor; wstring description; Icon applicationModuleIcon; } ;

[0058] Description

[0059] The ApplicationModuleAttributes structure is used to characterize the attributes of an Application Module.

[0060] The platformName attribute is used only to applications that do not run on the standard FAV. This allows proprietary or platform-specific applications to be recognized (or ignored) in HAVi. If the platformName is an empty string the standard HAVi-platform is used.

[0061] ApplicationModuleList

[0062] typedef sequence<HUID>ApplicationModuleList;

[0063] Description

[0064] The ApplicationModuleList contains a list of Application Modules HUID's.

[0065] Application Module Manager API

[0066] AMManager::ExecApplicationModule

[0067] Prototype

[0068] Status AMManager::ExecApplicationModule(in HUID huid, out SEID seid)

[0069] Parameters

[0070] huid—identifies the Application Module

[0071] seid—the SEID of the running Application Module

[0072] Description

[0073] AMManager::ExecApplicationModule loads and executes (starts) the Application Module. The SEID of the running (registered) Application Module is returned.

[0074] If the Application Module could not be found an error is returned. An error will also be returned if the Application Module is not executable, for example if it is not compatible with the platform from where it was called or the execution failed.

[0075] Error codes

[0076] AMManager::ENOT_EXECUTABLE—the Application Module is not executable on this FAV

[0077] AMManager::ENOT_FOUND—the Application Module could not be found

[0078] AMManager::EAM_EXECTUTION_FAILED—Application Module is now not executable

[0079] AMManager::LOADING_FAILED—Application Module is not loadable

[0080] AMManager::GetApplicationModules

[0081] Prototype

[0082] Status AMManager::GetApplicationModules(out ApplicationModuleList applicationModuleList)

[0083] Parameters

[0084] applicationModuleList—the list of the HUID's of Application Modules

[0085] Description

[0086] AMManager::GetApplicationModules returns a list of only the Application Modules HUID's. The list contains the local HUID's if it is a global call or it contains the HUID's of all Application Modules which are in the network if it is a call from the local AMManager. If there are not any Application Modules within the network an empty list will be returned.

[0087] AMManager::GetApplicationModuleAttributes

[0088] Prototype

[0089] Status AMManager::GetApplicationModuleAttributes (in HUID huid, out ApplicationModuleAttributes applicationModuleAttributes)

[0090] Parameters

[0091] huid—the HUID of the Application Module

[0092] applicationModuleAttributes—contains the attributes of the Application Module

[0093] Description

[0094] AMManager: :GetApplicationModuleAttributes returns the attributes of the Application Module specified by its HUID.

[0095] Error codes

[0096] AMManager::ENOT_FOUND—the Application Module could not be found

[0097] AMManager::InstallApplicationModule

[0098] Prototype

[0099] Status AMManager::InstallApplicationModule(in sequence<octet>applicationModule, out HUID huid)

[0100] Parameters

[0101] applicationModule—the Bytecode of the Application Module

[0102] huid—identifies the Application Module

[0103] Description

[0104] AMManager::InstallApplication installs the Application Module on the FAV. After installing the code the Application Module is presented in the Application Module List which is be held by the FAVs Application Module Manager. With GetApplicationModule it is possible to get this list.

[0105] Error codes

[0106] AMManager::ENOT_FOUND—the Application Module could not be found

[0107] AMManager::ENOT_ENOUGH_MEMORY—there is not enough memory left

[0108] AMManager::EACCESS_VIOLATION—the caller of an API does not have permission to perform the operation.

[0109] AMManager: :KillApplicationModule

[0110] Prototype

[0111] Status AMManager::KillApplicationModule(in SEID seid)

[0112] Parameters

[0113] seid—identifies the running Application Module

[0114] Description

[0115] AMManager: :KillApplicationModule kills a running Application Module. The SEID of the Application Module will be removed from the Registry. The kill command is intented to be used only in exceptional circumstances, for example when the Application Module is not longer responding.

[0116] Errorcodes

[0117] AMManager::ENOT_FOUND—the Application Module could not be found

[0118] AMManager::ENOT_POSSIBLE—the Application Module is not killable

[0119] AMManager::TransferApplicationModule

[0120] Prototype

[0121] Status AMManager::TransferApplicationModule(in Huid huid, out sequence<octet>applicationModule)

[0122] Parameters

[0123] huid—identifies the Application Module

[0124] applicationModule—the Bytecode of the Application Module

[0125] Description

[0126] AMManager: :TransferApplicationModule returns the code of the Application Module identified by the HUID from the called AMManager to the calling AMManager.

[0127] Error codes

[0128] AMManager::ENOT_FOUND—the Application Module could not be found

[0129] AMManager: : EACCESS_VIOLATION—the caller of an API does not have permission to perform the operation

[0130] AMManager: :UninstalLApplicationModule

[0131] Prototype

[0132] Status AMManager::UninstallApplicationModule(in Huid huid)

[0133] Parameters

[0134] huid—identifies the Application Module

[0135] Description

[0136] AMManager::UninstallApplicationModule uninstall the Application Module. The Application Module will be deleted from the list that is held by the Application Module Manager.

[0137] Error codes

[0138] AMManager::ENOT_FOUND—the Application Module could not be found

[0139] AMManager: : EACCESS_VIOLATION—the caller of an API does not have permission to perform the operation

[0140] Application Module Manager Events

[0141] Aminstallindication

[0142] Prototype

[0143] void AmInstallIndication(in Huid huid)

[0144] Parameters

[0145] huid—identifies the new Application Module

[0146] Description

[0147] The AMManager generates this event after installing the Application Module on the FAV.

[0148] AmUninstallindication

[0149] Prototype

[0150] void AmUninstallIndication(in Huid huid)

[0151] Parameters

[0152] huid—identifies the uninstalled Application Module

[0153] Description

[0154] This event is generated when an Application Module is been uninstalled.

[0155] AmExecindication

[0156] Prototype

[0157] void AmExecIndication(in Seid seid)

[0158] Parameters

[0159] seid—identifies the running Application Module

[0160] Description

[0161] After an Application Module is started the event AmExecIndication is send.

[0162] AmKillIndication

[0163] Prototype

[0164] void AmKillIndication(in SEID seid)

[0165] Parameters

[0166] seid—identifies the killed Application Module

[0167] Description

[0168] Killing an Application Module causes this event. 

1. Method to manage application modules (5 a; 5 b) within a controller device (1 a, 2 a; 1 b-3 b) of a network, characterized by maintaining a database of application modules (5 a; 5 b) provided by said controller device (1 a, 2 a; 1 b-3 b) and allowing access to said database via the network; and providing application program interfaces for managing the behaviour of application modules (5 a; 5 b) provided by said controller device (1 a, 2 a; 1 b-3b) and provided by other controller devices (1 a, 2 a; 1 b-3 b) within the network to said controller device (1 a, 2 a; 1 b-3 b).
 2. Method according to claim 1, characterized in that said behaviour of an application module (5 a; 5 b) comprises import/export, execution and termination of said application module (5 a; 5 b).
 3. Method according to claim 1 or 2, characterized by the step of listing all application modules (5 a; 5 b) which are available within the network and providing said list to said controller device (1 a, 2 a; 1 b-3 b).
 4. Method according to anyone of the preceding claims, characterized in that said application modules (5 a; 5 b) are not bound to a particular controller device (1 a, 2 a; 1 b-3 b).
 5. Method according to anyone of the preceding claims, characterized in that said network is a HAVi network.
 6. Method according to claim 5, characterized in that said application modules (5 a; 5 b) are havlets which are HAVi level-2 GUI compliant.
 7. Method according to claim 5 or 6, characterized by the step of controlling the exposure and loading of an application module (5 a; 5 b) similar to the control of a device control module manager for device control module code modules, but allowing a sharing of an application module between more that one controller device (1 a, 2 a; 1 b-3 b) within said network.
 8. Method according to claim 7, characterized in that sharing an application module (5 a; 5 b) between more that one controller device (1 a, 2 a; 1 b-3 b) within said network means: to concurrently execute an application module (5 a) independently on more than one controller device (1 a, 2 a), to concurrently execute an application module (5 a) on more than one controller device (1 a, 2 a) so that an interaction in-between the controller devices (1 a, 2 a) executing said application module is performed based on said application module (5 a), an application-specific user interaction which means that a controller device (1 b) which provided or first executed the application module (5 b) acts as a server and all other controller devices (2 b, 3 b) which executed the application module (5 b) thereafter act as clients, and/or an application module uses a common data base stored somewhere in the network.
 9. Application module manager for a network, characterized by being able to carry out the method defined in anyone of claims 1 to
 8. 10. Application module manager according to claim 9, characterized by being loadable into said controller device (1 a, 2 a; 1 b-3 b).
 11. Computer program product comprising program code means to carry out the method defined in anyone of claims 1 to 8 when being executed on a computer and/or said controller device (1 a, 2 a; 1 b-3 b).
 12. Computer program product comprising program code means according to claim 11 being stored on a computer and/or controller device (1 a, 2 a; 1 b-3 b) accessable storage means. 